R6 Checklist for Encounter

Artifact Encounter (Encounter)

Urgent Item Checklist

All Analysis Information

The following content was generated to assist in the review of this artifact for R6 compliance.

Information Page

General Information:

Page File Name encounter-introduction.xml
Responsible Workgroup pa
Maturity Label Active
Maturity Level 4
Standards Status normative
Management Comments
Workgroup Comments
Exists In publish.ini No
Exists In Source Directory Yes
'deprecated' Literal Count 0
Zulip Link Count 0
Confluence Link Count 0

Conformance Language Summary

'Conformant' conformance language appears in all-upper case. 'Non-conformant' covers all other cases appearing in the content.

Literal Conformant Non-Conformant
SHALL 0 0
SHALL NOT 0 0
SHOULD 0 3
SHOULD NOT 0 0
MAY 0 8
MAY NOT 0 0

Possibly Removed FHIR Artifact Literals Found on Page

Word Artifact Class
EncounterHistoryResource

Unknown Words Found on Page

Word Known Typo
classHistoryNo
doesn'tYes
partOfNo
remediatesNo
status/subjectStatusNo
statusHistoryNo
subjectStatusNo
triagedNo

Images with Issues

Source Missing Alt Text Not In Figure Tag

Possible Incomplete Markers Found on Page

Reader Review Notes Found on Page

Notes Page

General Information:

Page File Name encounter-notes.xml
Responsible Workgroup pa
Maturity Label Active
Maturity Level 4
Standards Status normative
Management Comments
Workgroup Comments
Exists In publish.ini No
Exists In Source Directory Yes
'deprecated' Literal Count 0
Zulip Link Count 0
Confluence Link Count 0

Conformance Language Summary

'Conformant' conformance language appears in all-upper case. 'Non-conformant' covers all other cases appearing in the content.

Literal Conformant Non-Conformant
SHALL 0 0
SHALL NOT 0 0
SHOULD 0 1
SHOULD NOT 0 0
MAY 0 2
MAY NOT 0 0

Possibly Removed FHIR Artifact Literals Found on Page

Word Artifact Class

Unknown Words Found on Page

Word Known Typo
partOfNo

Images with Issues

Source Missing Alt Text Not In Figure Tag

Possible Incomplete Markers Found on Page

Reader Review Notes Found on Page

Element Review

Path Is Required Max Cardinality Trial Use Has fixed[x] Has pattern[x] Required Binding External Required Binding Check meaningWhenMissing Is Modifier
Encounter *
Encounter.identifier *
Encounter.status X 1 Has 'unknown' X
Encounter.businessStatus *
Encounter.businessStatus.code X 1
Encounter.businessStatus.type 1
Encounter.businessStatus.effectiveDate 1
Encounter.class *
Encounter.priority 1
Encounter.type *
Encounter.serviceType *
Encounter.subject 1
Encounter.subjectStatus 1
Encounter.episodeOfCare *
Encounter.basedOn *
Encounter.careTeam *
Encounter.partOf 1
Encounter.serviceProvider 1
Encounter.participant *
Encounter.participant.type *
Encounter.participant.period 1
Encounter.participant.actor 1
Encounter.appointment *
Encounter.virtualService *
Encounter.actualPeriod 1
Encounter.plannedStartDate 1
Encounter.plannedEndDate 1
Encounter.length 1
Encounter.reason *
Encounter.reason.use *
Encounter.reason.value *
Encounter.diagnosis *
Encounter.diagnosis.condition *
Encounter.diagnosis.use *
Encounter.account *
Encounter.dietPreference *
Encounter.specialArrangement *
Encounter.specialCourtesy *
Encounter.admission 1
Encounter.admission.preAdmissionIdentifier 1
Encounter.admission.origin 1
Encounter.admission.admitSource 1
Encounter.admission.reAdmission 1
Encounter.admission.destination 1
Encounter.admission.dischargeDisposition 1
Encounter.location *
Encounter.location.location X 1
Encounter.location.status 1 optional - NO 'other' or 'unknown' X
Encounter.location.form 1
Encounter.location.period 1

Operations

Id Name Publication Status FMM Standards Status IsExperimental Workgroup Description
Encounter-everything Everything Active 2 normative False pa This operation is used to return all the information related to an encounter described in the resource on which this operation is invoked. The response is a bundle of type "searchset". At a minimum, the encounter resource itself is returned, along with any other resources that the server has available for the given encounter for the user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, locations, organizations etc. The principle intended use for this operation is to provide a patient with access to their record, or to allow a client to retrieve everything for an encounter for efficient display). The server SHOULD return all resources it has that: * are included in the encounter compartment for the identified encounter (have a reference to the encounter) * are referenced by the standard extenstion for associating an encounter (where no reference element exists) http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter * the server believes are relevant to the context of the encounter for any other reason (internally defined/decided) * any resource referenced by the above, including binaries and attachments (to make a more complete package) Implementation guides may make additional rules about how much information that is returned. Note that for many resources, the exact nature of the link to encounter can be ambiguous (e.g. for a DiagnosticReport, is it the encounter when it was initiated, or when it was reported?)

Search Parameters

Id Name Publication Status FMM Standards Status IsExperimental WorkGroup Search Type Description
Encounter-account account Active normative False pa reference The set of accounts that may be used for billing for this Encounter
Encounter-appointment appointment Active normative False pa reference The appointment that scheduled this encounter
Encounter-based-on based-on Active normative False pa reference The ServiceRequest that initiated this encounter
Encounter-business-status business-status Active normative False pa token The current business status of the Encounter
Encounter-careteam careteam Active normative False pa reference Careteam allocated to participate in the encounter
Encounter-class class Active normative False pa token Classification of patient encounter
Encounter-date-start date-start Active normative False pa date The actual start date of the Encounter
Encounter-diagnosis-code diagnosis-code Active normative False pa token The diagnosis or procedure relevant to the encounter (coded)
Encounter-diagnosis-reference diagnosis-reference Active normative False pa reference The diagnosis or procedure relevant to the encounter (resource reference)
Encounter-end-date end-date Active normative False pa date The actual end date of the Encounter
Encounter-episode-of-care episode-of-care Active normative False pa reference Episode(s) of care that this encounter should be recorded against
Encounter-length length Active normative False pa quantity Length of encounter in days
Encounter-location location Active normative False pa reference Location the encounter takes place
Encounter-location-period location-period Active normative False pa date Time period during which the patient was present at a location (generally used via composite location-period)
Encounter-location-value-period location-value-period Active normative False pa composite Time period during which the patient was present at the location
Encounter-part-of part-of Active normative False pa reference Another Encounter this encounter is part of
Encounter-participant participant Active normative False pa reference Persons involved in the encounter other than the patient
Encounter-participant-type participant-type Active normative False pa token Role of participant in encounter
Encounter-practitioner practitioner Active normative False pa reference Persons involved in the encounter other than the patient
Encounter-reason-code reason-code Active normative False pa token Reference to a concept (coded)
Encounter-reason-reference reason-reference Active normative False pa reference Reference to a resource (resource reference)
Encounter-service-provider service-provider Active normative False pa reference The organization (facility) responsible for this encounter
Encounter-special-arrangement special-arrangement Active normative False pa token Wheelchair, translator, stretcher, etc.
Encounter-status status Active normative False pa token planned | in-progress | on-hold | completed | cancelled | entered-in-error | unknown
Encounter-subject subject Active normative False pa reference The patient or group present at the encounter
Encounter-subject-status subject-status Active normative False pa token The current status of the subject in relation to the Encounter
clinical-date date Active normative False pc date Multiple Resources: * [AllergyIntolerance](http://hl7.org/fhir/R6/allergyintolerance.html): Date first version of the resource instance was recorded * [Appointment](http://hl7.org/fhir/R6/appointment.html): Appointment date/time. * [AuditEvent](http://hl7.org/fhir/R6/auditevent.html): Time when the event was recorded * [CarePlan](http://hl7.org/fhir/R6/careplan.html): Time period plan covers * [CareTeam](http://hl7.org/fhir/R6/careteam.html): A date within the coverage time period. * [Composition](http://hl7.org/fhir/R6/composition.html): Composition editing time * [Consent](http://hl7.org/fhir/R6/consent.html): When consent was agreed to * [DiagnosticReport](http://hl7.org/fhir/R6/diagnosticreport.html): The clinically relevant time of the report * [DocumentReference](http://hl7.org/fhir/R6/documentreference.html): When this document reference was created * [Encounter](http://hl7.org/fhir/R6/encounter.html): A date within the actualPeriod the Encounter lasted * [EpisodeOfCare](http://hl7.org/fhir/R6/episodeofcare.html): The provided date search value falls within the episode of care's period * [FamilyMemberHistory](http://hl7.org/fhir/R6/familymemberhistory.html): When history was recorded or last updated * [Flag](http://hl7.org/fhir/R6/flag.html): Time period when flag is active * [Immunization](http://hl7.org/fhir/R6/immunization.html): Vaccination (non)-Administration Date * [Invoice](http://hl7.org/fhir/R6/invoice.html): Invoice date / posting date * [List](http://hl7.org/fhir/R6/list.html): When the list was prepared * [MeasureReport](http://hl7.org/fhir/R6/measurereport.html): The date of the measure report * [NutritionIntake](http://hl7.org/fhir/R6/nutritionintake.html): Date when patient was taking (or not taking) the medication * [Observation](http://hl7.org/fhir/R6/observation.html): Clinically relevant time/time-period for observation * [Procedure](http://hl7.org/fhir/R6/procedure.html): When the procedure occurred or is occurring * [ResearchSubject](http://hl7.org/fhir/R6/researchsubject.html): Start and end of participation * [RiskAssessment](http://hl7.org/fhir/R6/riskassessment.html): When was assessment made?
clinical-identifier identifier Active normative False pa token Multiple Resources: * [Account](http://hl7.org/fhir/R6/account.html): Account number * [AdverseEvent](http://hl7.org/fhir/R6/adverseevent.html): Business identifier for the event * [AllergyIntolerance](http://hl7.org/fhir/R6/allergyintolerance.html): External ids for this item * [Appointment](http://hl7.org/fhir/R6/appointment.html): An Identifier of the Appointment * [AppointmentResponse](http://hl7.org/fhir/R6/appointmentresponse.html): An Identifier in this appointment response * [Basic](http://hl7.org/fhir/R6/basic.html): Business identifier * [BiologicallyDerivedProduct](http://hl7.org/fhir/R6/biologicallyderivedproduct.html): Identifier * [BodyStructure](http://hl7.org/fhir/R6/bodystructure.html): Bodystructure identifier * [CarePlan](http://hl7.org/fhir/R6/careplan.html): External Ids for this plan * [CareTeam](http://hl7.org/fhir/R6/careteam.html): External Ids for this team * [Claim](http://hl7.org/fhir/R6/claim.html): The primary identifier of the financial resource * [ClaimResponse](http://hl7.org/fhir/R6/claimresponse.html): The identity of the ClaimResponse * [Communication](http://hl7.org/fhir/R6/communication.html): Unique identifier * [CommunicationRequest](http://hl7.org/fhir/R6/communicationrequest.html): Unique identifier * [Composition](http://hl7.org/fhir/R6/composition.html): Version-independent identifier for the Composition * [Condition](http://hl7.org/fhir/R6/condition.html): A unique identifier of the condition record * [Consent](http://hl7.org/fhir/R6/consent.html): Identifier for this record (external references) * [Contract](http://hl7.org/fhir/R6/contract.html): The identity of the contract * [Coverage](http://hl7.org/fhir/R6/coverage.html): The primary identifier of the insured and the coverage * [CoverageEligibilityRequest](http://hl7.org/fhir/R6/coverageeligibilityrequest.html): The business identifier of the Eligibility * [CoverageEligibilityResponse](http://hl7.org/fhir/R6/coverageeligibilityresponse.html): The business identifier * [DetectedIssue](http://hl7.org/fhir/R6/detectedissue.html): Unique id for the detected issue * [DeviceRequest](http://hl7.org/fhir/R6/devicerequest.html): Business identifier for request/order * [DiagnosticReport](http://hl7.org/fhir/R6/diagnosticreport.html): An identifier for the report * [DocumentReference](http://hl7.org/fhir/R6/documentreference.html): Identifier of the attachment binary * [Encounter](http://hl7.org/fhir/R6/encounter.html): Identifier(s) by which this encounter is known * [EnrollmentRequest](http://hl7.org/fhir/R6/enrollmentrequest.html): The business identifier of the Enrollment * [EpisodeOfCare](http://hl7.org/fhir/R6/episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare * [ExplanationOfBenefit](http://hl7.org/fhir/R6/explanationofbenefit.html): The business identifier of the Explanation of Benefit * [FamilyMemberHistory](http://hl7.org/fhir/R6/familymemberhistory.html): A search by a record identifier * [Flag](http://hl7.org/fhir/R6/flag.html): Business identifier * [Goal](http://hl7.org/fhir/R6/goal.html): External Ids for this goal * [GuidanceResponse](http://hl7.org/fhir/R6/guidanceresponse.html): The identifier of the guidance response * [ImagingSelection](http://hl7.org/fhir/R6/imagingselection.html): Identifiers for the imaging selection * [ImagingStudy](http://hl7.org/fhir/R6/imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID * [Immunization](http://hl7.org/fhir/R6/immunization.html): Business identifier * [Invoice](http://hl7.org/fhir/R6/invoice.html): Business Identifier for item * [List](http://hl7.org/fhir/R6/list.html): Business identifier * [MeasureReport](http://hl7.org/fhir/R6/measurereport.html): External identifier of the measure report to be returned * [Medication](http://hl7.org/fhir/R6/medication.html): Returns medications with this external identifier * [MedicationAdministration](http://hl7.org/fhir/R6/medicationadministration.html): Return administrations with this external identifier * [MedicationDispense](http://hl7.org/fhir/R6/medicationdispense.html): Returns dispenses with this external identifier * [MedicationRequest](http://hl7.org/fhir/R6/medicationrequest.html): Return prescriptions with this external identifier * [MedicationStatement](http://hl7.org/fhir/R6/medicationstatement.html): Return statements with this external identifier * [NutritionIntake](http://hl7.org/fhir/R6/nutritionintake.html): Return statements with this external identifier * [NutritionOrder](http://hl7.org/fhir/R6/nutritionorder.html): Return nutrition orders with this external identifier * [Observation](http://hl7.org/fhir/R6/observation.html): The unique id for a particular observation * [Person](http://hl7.org/fhir/R6/person.html): A person Identifier * [Procedure](http://hl7.org/fhir/R6/procedure.html): A unique identifier for a procedure * [QuestionnaireResponse](http://hl7.org/fhir/R6/questionnaireresponse.html): The unique identifier for the questionnaire response * [RelatedPerson](http://hl7.org/fhir/R6/relatedperson.html): An Identifier of the RelatedPerson * [RequestOrchestration](http://hl7.org/fhir/R6/requestorchestration.html): External identifiers for the request orchestration * [ResearchSubject](http://hl7.org/fhir/R6/researchsubject.html): Business Identifier for research subject in a study * [RiskAssessment](http://hl7.org/fhir/R6/riskassessment.html): Unique identifier for the assessment * [ServiceRequest](http://hl7.org/fhir/R6/servicerequest.html): Identifiers assigned to this order * [Specimen](http://hl7.org/fhir/R6/specimen.html): The unique identifier associated with the specimen * [Task](http://hl7.org/fhir/R6/task.html): Search for a task instance by its business identifier * [VisionPrescription](http://hl7.org/fhir/R6/visionprescription.html): Return prescriptions with this external identifier
clinical-patient patient Active normative False pa reference Multiple Resources: * [Account](http://hl7.org/fhir/R6/account.html): The entity that caused the expenses * [AdverseEvent](http://hl7.org/fhir/R6/adverseevent.html): Subject impacted by event * [AllergyIntolerance](http://hl7.org/fhir/R6/allergyintolerance.html): Who the sensitivity is for * [Appointment](http://hl7.org/fhir/R6/appointment.html): One of the individuals of the appointment is this patient * [AppointmentResponse](http://hl7.org/fhir/R6/appointmentresponse.html): This Response is for this Patient * [AuditEvent](http://hl7.org/fhir/R6/auditevent.html): Where the activity involved patient data * [Basic](http://hl7.org/fhir/R6/basic.html): Identifies the focus of this resource * [BiologicallyDerivedProduct](http://hl7.org/fhir/R6/biologicallyderivedproduct.html): The patient who underwent the procedure to collect the product * [BodyStructure](http://hl7.org/fhir/R6/bodystructure.html): Who this is about * [CarePlan](http://hl7.org/fhir/R6/careplan.html): Who the care plan is for * [CareTeam](http://hl7.org/fhir/R6/careteam.html): Who care team is for * [Claim](http://hl7.org/fhir/R6/claim.html): Patient receiving the products or services * [ClaimResponse](http://hl7.org/fhir/R6/claimresponse.html): The subject of care * [Communication](http://hl7.org/fhir/R6/communication.html): Focus of message * [CommunicationRequest](http://hl7.org/fhir/R6/communicationrequest.html): Focus of message * [Composition](http://hl7.org/fhir/R6/composition.html): Who and/or what the composition is about * [Condition](http://hl7.org/fhir/R6/condition.html): Who has the condition? * [Consent](http://hl7.org/fhir/R6/consent.html): Who the consent applies to * [Contract](http://hl7.org/fhir/R6/contract.html): The identity of the subject of the contract (if a patient) * [Coverage](http://hl7.org/fhir/R6/coverage.html): Retrieve coverages for a patient * [CoverageEligibilityRequest](http://hl7.org/fhir/R6/coverageeligibilityrequest.html): The reference to the patient * [CoverageEligibilityResponse](http://hl7.org/fhir/R6/coverageeligibilityresponse.html): The reference to the patient * [DetectedIssue](http://hl7.org/fhir/R6/detectedissue.html): Associated patient * [DeviceAssociation](http://hl7.org/fhir/R6/deviceassociation.html): The patient associated with the device * [DeviceRequest](http://hl7.org/fhir/R6/devicerequest.html): Individual the service is ordered for * [DiagnosticReport](http://hl7.org/fhir/R6/diagnosticreport.html): The subject of the report if a patient * [DocumentReference](http://hl7.org/fhir/R6/documentreference.html): Who/what is the subject of the document * [Encounter](http://hl7.org/fhir/R6/encounter.html): The patient present at the encounter * [EnrollmentRequest](http://hl7.org/fhir/R6/enrollmentrequest.html): The party to be enrolled * [EpisodeOfCare](http://hl7.org/fhir/R6/episodeofcare.html): The patient who is the focus of this episode of care * [ExplanationOfBenefit](http://hl7.org/fhir/R6/explanationofbenefit.html): The reference to the patient * [FamilyMemberHistory](http://hl7.org/fhir/R6/familymemberhistory.html): The identity of a subject to list family member history items for * [Flag](http://hl7.org/fhir/R6/flag.html): The identity of a subject to list flags for * [Goal](http://hl7.org/fhir/R6/goal.html): Who this goal is intended for * [GuidanceResponse](http://hl7.org/fhir/R6/guidanceresponse.html): The identity of a patient to search for guidance response results * [ImagingSelection](http://hl7.org/fhir/R6/imagingselection.html): Who the study is about * [ImagingStudy](http://hl7.org/fhir/R6/imagingstudy.html): Who the study is about * [Immunization](http://hl7.org/fhir/R6/immunization.html): The patient for the vaccination record * [Invoice](http://hl7.org/fhir/R6/invoice.html): Recipient(s) of goods and services * [List](http://hl7.org/fhir/R6/list.html): If all resources have the same subject * [MeasureReport](http://hl7.org/fhir/R6/measurereport.html): The identity of a patient to search for individual measure report results for * [MedicationAdministration](http://hl7.org/fhir/R6/medicationadministration.html): The identity of a patient to list administrations for * [MedicationDispense](http://hl7.org/fhir/R6/medicationdispense.html): The identity of a patient to list dispenses for * [MedicationRequest](http://hl7.org/fhir/R6/medicationrequest.html): Returns prescriptions for a specific patient * [MedicationStatement](http://hl7.org/fhir/R6/medicationstatement.html): Returns statements for a specific patient. * [NutritionIntake](http://hl7.org/fhir/R6/nutritionintake.html): Returns statements for a specific patient. * [NutritionOrder](http://hl7.org/fhir/R6/nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement * [Observation](http://hl7.org/fhir/R6/observation.html): The subject that the observation is about (if patient) * [Person](http://hl7.org/fhir/R6/person.html): The Person links to this Patient * [Procedure](http://hl7.org/fhir/R6/procedure.html): Search by subject - a patient * [Provenance](http://hl7.org/fhir/R6/provenance.html): Where the activity involved patient data * [QuestionnaireResponse](http://hl7.org/fhir/R6/questionnaireresponse.html): The patient that is the subject of the questionnaire response * [RelatedPerson](http://hl7.org/fhir/R6/relatedperson.html): The patient this related person is related to * [RequestOrchestration](http://hl7.org/fhir/R6/requestorchestration.html): The identity of a patient to search for request orchestrations * [ResearchSubject](http://hl7.org/fhir/R6/researchsubject.html): Who or what is part of study * [RiskAssessment](http://hl7.org/fhir/R6/riskassessment.html): Who/what does assessment apply to? * [ServiceRequest](http://hl7.org/fhir/R6/servicerequest.html): Search by subject - a patient * [Specimen](http://hl7.org/fhir/R6/specimen.html): The patient the specimen comes from * [Task](http://hl7.org/fhir/R6/task.html): Search by patient * [VisionPrescription](http://hl7.org/fhir/R6/visionprescription.html): The identity of a patient to list dispenses for
clinical-type type Active normative False pa token Multiple Resources: * [Account](http://hl7.org/fhir/R6/account.html): E.g. patient, expense, depreciation * [AllergyIntolerance](http://hl7.org/fhir/R6/allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known) * [Composition](http://hl7.org/fhir/R6/composition.html): Kind of composition (LOINC if possible) * [Coverage](http://hl7.org/fhir/R6/coverage.html): The kind of coverage (health plan, auto, Workers Compensation) * [DocumentReference](http://hl7.org/fhir/R6/documentreference.html): Kind of document (LOINC if possible) * [Encounter](http://hl7.org/fhir/R6/encounter.html): Specific type of encounter * [EpisodeOfCare](http://hl7.org/fhir/R6/episodeofcare.html): Type/class - e.g. specialist referral, disease management * [Invoice](http://hl7.org/fhir/R6/invoice.html): Type of Invoice * [MedicationDispense](http://hl7.org/fhir/R6/medicationdispense.html): Returns dispenses of a specific type * [Specimen](http://hl7.org/fhir/R6/specimen.html): The specimen type